Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposed affliated package: pdr #9

Merged
merged 2 commits into from
Dec 27, 2023
Merged

Conversation

Sierra-MC
Copy link

The planetary data reader (pdr) has finally gotten our tests and documentation to a state for which we are ready to submit to planetarypy. pdr is under active development and continues to expand the number of datasets we have official support for; it is intended that we will read all PDS compliant data by the end of the project. Please reach out if you have any questions. Thank you for your time and consideration.

@AndrewAnnex AndrewAnnex self-assigned this Nov 8, 2023
@AndrewAnnex
Copy link
Member

@Sierra-MC thanks for your submission. I will be your TC review coordinator. I have reached out to a reviewer and will update you as we progress through our review.

@AndrewAnnex
Copy link
Member

@Sierra-MC I'm happy to confirm that your package is now under review and we'll post the results of the review here.

@Sierra-MC
Copy link
Author

@AndrewAnnex, thank you very much! We look forward to the results.

@AndrewAnnex
Copy link
Member

@Sierra-MC This package has been reviewed for inclusion in the PlanetaryPy
affiliated package ecosystem by a member of the PlanetaryPy community
as well as myself, and I have synthesized the results of the review
here.

You can find out more about our review criteria in our
Review Guidelines.
For each of the review categories below we have listed the score and have
included some comments when the score is not green.

Functionality/Scope General
PDR is a core building block that will likely be widely useful across a range of planetary science python workflows and pipelines.
Integration with PlanetaryPy ecosystem Good"
Uses commonly used and tested python packages (e.g., pds4_tools, astropy.fits) and will provide new core functionality not yet under the PlanetaryPy umbrella
Documentation Good"
Documentation is clear, extensive and the conda installation instructions and minimal example work as described. The binder example notebook is a great extra touch, as is the clear and easy access Zenodo DOI badge.
Testing Good"
Authors have communicated to the review panel that tests are run but not in CI/CD pipeline due to the large size of PDS data products required. Tests of all possible datasets is probably intractable and tests of the codebase look adequate. In lieu of CI, there is an included list of currently supported datasets and clear directions to open an issue if a certain dataset fails to open, providing a path for users to notify maintainers about bugs / feature requests. The issue board appears well used and issues are replied to promptly, often with fixes, increasing the chances that bugs are caught and addressed quickly.
Development status Good"
No further comments
Python version compatibility 3.9"
No further comments

Summary/Decision: Everything looks great, and we're happy to confirm that
this package is accepted as an affiliated package! 🏆

Please remember that if your package doesn't explicitly have a set
of governance documents, that's fine! The PlanetaryPy Project's
governance models (consensus seeking, code of conduct, etc.)
automatically apply to your project. If you want something different,
be sure to include it in your package.

If you have any follow-up questions or disagree with any of the comments above,
leave a comment and we can discuss it here. At any point in future you can
request a re-review of the package if you believe any of the scores should be
updated - contact the coordination committee, and we’ll do a new review.

I will go about editing this pr to include the review results.

add review result
@Sierra-MC
Copy link
Author

Thank you very much @AndrewAnnex. We appreciate the time and effort it took you and the review team to put together this report. What a great Holiday present to be a part of planetarypy!! 🥳

@rbeyer rbeyer merged commit 22121ff into planetarypy:src Dec 27, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants